home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 42 / Amiga Format AFCD42 (Issue 126, Aug 1999).iso / -serious- / programming / other / gui4cli / tools / fastread / makedoc.doc < prev    next >
Text File  |  1999-05-14  |  3KB  |  66 lines
  1.  
  2.  
  3.                               MAKEDOC.GC
  4.                              ------------
  5.      A document assembler for use with the FastRead Help System.
  6.  
  7. Introduction
  8. ------------
  9. The purpose of MakeDoc is to make life a little easier when writing
  10. help files or documentation for Gui4Cli's FastRead help system. By
  11. writing each section separately and saving the resulting text files
  12. separately, MakeDoc will join them all together into one file in the
  13. order specified, also adding the '@database' header and inserting the
  14. '@node' and '@endnode' lines where appropriate, making the document
  15. compatible with AmigaGuide. This method of writing documentation also
  16. has the advantage of being easy to update any individual section, and
  17. re compiling a new document with MakeDoc.
  18.  
  19. The name of the specified target file will by default be used as the
  20. database title, and each inividual file name which is selected for
  21. joining will be used for its corresponding node title.
  22.  
  23. Requirements
  24. ------------
  25. MakeDoc needs the Type command in C: and Gui4Cli version 3.0 minimum.
  26.  
  27. Usage and the User Interface
  28. ----------------------------
  29. Apart from the buttons, the MakeDoc gui is composed mainly of two
  30. listviews. The left hand lister reads in the contents of the directory
  31. containing the files to be joined. The right hand lister holds the
  32. names of the files which have been selected in the left hand one.
  33. These are the files which will be operated on, and the right hand
  34. lister is the one which does the work.
  35.  
  36. At the top of the gui is the 'Outfile' button, with a string gadget
  37. next to it. These are for specifying the path and name of the target
  38. file. The target file can be specified by typing directly into the
  39. string gadget, and if a filename is typed in without a path, the
  40. target file will be created in the same directory as the source files.
  41. The Outfile button produces a file requester, and automatically
  42. inserts the full path and name of the target file. The joining
  43. operation cannot be started until a target file is specified by either
  44. of these two methods.
  45.  
  46. Over the top of the listers are all the buttons for file manipulation.
  47. Files from the left hand lister are transferred over to the right
  48. lister by first selecting them and then clicking on the 'Xfer' button.
  49. Single files can be transferred one at a time by double clicking on
  50. them in the left lister. 
  51.  
  52. Once in the right lister, the files can be arranged in any order by
  53. clicking on the filename in the lister and using the 'Up' and 'Down'
  54. buttons, or pressing the U and D keys. Individual files can be erased
  55. from the lister with the 'Remove' button, or the lister cleared at any
  56. time with the 'Clear' button.
  57.  
  58. When all the files are in the correct order for joining, and a target
  59. file has been specified, the 'Start' button will become active, and
  60. the operation may be started. Until a target file has been specified
  61. in the string gadget or by the 'Outfile' button, the Start button is
  62. ghosted. It will ghost again when the joining operation finishes, and
  63. the right lister and string gadget will clear.
  64.  
  65. gmaddox@netcentral.co.uk
  66.